Skip to main content
GET
/
v1
/
receiving
/
{type}
/
{id}
Get one Delivery
curl --request GET \
  --url https://{base_url_domain}/api/global/v1/receiving/{type}/{id} \
  --header 'Authorization: Bearer <token>'
{
  "resource": {
    "type": "ASN",
    "warehouse": {
      "type": "Warehouse",
      "id": 123
    },
    "id": 123,
    "supplier_name": "<string>",
    "expected_at": "2019-12-03T21:06:26Z",
    "merchant_reference": "<string>",
    "supplier_invoice_reference": "<string>",
    "supplier_order_reference": "<string>",
    "shipment_type": "international_maritime_freight",
    "bill_of_lading": "<string>",
    "standard_carrier_alpha_code": "<string>",
    "merchant": {
      "type": "Merchant",
      "id": 4
    },
    "increment_id": "11000020",
    "state": "new",
    "status": "new",
    "progress_percent": 50,
    "carrier_name": "<string>",
    "delivered_at": "2019-12-03T21:06:26Z",
    "receive_by": "2019-12-03T21:06:26Z",
    "processed_at": "2019-12-03T21:06:26Z",
    "putaway_at": "2019-12-03T21:06:26Z",
    "completed_at": "2019-12-03T21:06:26Z",
    "ready_to_process_at": "2019-12-03T21:06:26Z",
    "merchant_status": "<string>",
    "item_count": 123,
    "container_count": 123,
    "label_count": 123,
    "exception_count": 123,
    "processing_comments": "<string>",
    "special_requirements": [
      "<string>"
    ],
    "is_auto_commit": true,
    "created_at": "2017-07-21T17:32:28Z",
    "updated_at": "2017-07-21T17:39:43Z",
    "tracking_numbers": [
      "<string>"
    ],
    "status_history": [
      {
        "delivery_item": {
          "type": "DeliveryItem",
          "id": 3,
          "product": {
            "type": "Product",
            "id": 3
          },
          "quantity": 123,
          "qty_expected": 123,
          "qty_received": 123,
          "qty_shortage": 123,
          "qty_overage": 123,
          "qty_processed": 123,
          "qty_putaway": 123,
          "qty_committed": 123,
          "qty_returned": 123,
          "is_sku_merge_email_sent": true,
          "lots": [
            {
              "type": "DeliveryItemLot",
              "id": 3
            }
          ],
          "locations": [
            {
              "type": "DeliveryItemLocation",
              "id": 3
            }
          ],
          "exceptions": [
            {
              "type": "DeliveryException",
              "id": 3
            }
          ]
        },
        "status": "new",
        "exception": {
          "type": "Exception",
          "id": 123
        },
        "exception_status": "new",
        "comment": "<string>",
        "requester": {
          "type": "Requester",
          "id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "package": {
          "type": "Package",
          "id": 123
        }
      }
    ],
    "items": [
      {
        "type": "DeliveryItem",
        "id": 3,
        "product": {
          "type": "Product",
          "id": 3
        },
        "quantity": 123,
        "qty_expected": 123,
        "qty_received": 123,
        "qty_shortage": 123,
        "qty_overage": 123,
        "qty_processed": 123,
        "qty_putaway": 123,
        "qty_committed": 123,
        "qty_returned": 123,
        "is_sku_merge_email_sent": true,
        "lots": [
          {
            "type": "DeliveryItemLot",
            "id": 3
          }
        ],
        "locations": [
          {
            "type": "DeliveryItemLocation",
            "id": 3
          }
        ],
        "exceptions": [
          {
            "type": "DeliveryException",
            "id": 3
          }
        ]
      }
    ]
  },
  "included": {
    "DeliveryContainer": [
      {
        "type": "DeliveryContainer",
        "id": 3,
        "container_type": {
          "type": "DeliveryContainerType",
          "id": 3,
          "merchant": {
            "type": "Merchant",
            "id": 4
          },
          "delivery_type": "asn",
          "name": "<string>",
          "name_plural": "<string>",
          "weight": {
            "value": 20,
            "unit": "lb"
          },
          "is_default": true,
          "is_system": true
        },
        "damage_type": "none",
        "weight_discrepancy_reason": "none",
        "tare_weight": {
          "value": 20,
          "unit": "lb"
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "weighed_at": "2019-12-03T21:06:26Z",
        "weighed_by": {
          "type": "OrganizationUser",
          "id": 3
        },
        "contents": [
          {
            "delivery_item": {
              "type": "DeliveryItem",
              "id": 123
            },
            "qty_counted": 123,
            "qty_shortage": 123,
            "qty_counted_per_lot": [
              {
                "lot": {
                  "type": "Lot",
                  "id": 54
                },
                "quantity": 123
              }
            ]
          }
        ],
        "condition_note": "<string>",
        "item_count": 123
      }
    ],
    "DeliveryContainerType": [
      {
        "type": "DeliveryContainerType",
        "id": 3,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "delivery_type": "asn",
        "name": "<string>",
        "name_plural": "<string>",
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "is_default": true,
        "is_system": true
      }
    ],
    "DeliveryException": [
      {
        "type": "DeliveryException",
        "id": 3,
        "container": {
          "type": "DeliveryContainer",
          "id": 3
        },
        "lot": {
          "type": "Lot",
          "id": 54
        },
        "status": "new",
        "sign": -1,
        "reason": "<string>",
        "comment": "<string>",
        "quantity": 123
      }
    ],
    "DeliveryItem": [
      {
        "type": "DeliveryItem",
        "id": 3,
        "product": {
          "type": "Product",
          "id": 3
        },
        "quantity": 123,
        "qty_expected": 123,
        "qty_received": 123,
        "qty_shortage": 123,
        "qty_overage": 123,
        "qty_processed": 123,
        "qty_putaway": 123,
        "qty_committed": 123,
        "qty_returned": 123,
        "is_sku_merge_email_sent": true,
        "lots": [
          {
            "type": "DeliveryItemLot",
            "id": 3
          }
        ],
        "locations": [
          {
            "type": "DeliveryItemLocation",
            "id": 3
          }
        ],
        "exceptions": [
          {
            "type": "DeliveryException",
            "id": 3
          }
        ]
      }
    ],
    "DeliveryItemLocation": [
      {
        "type": "DeliveryItemLocation",
        "id": 3,
        "location": {
          "type": "Location",
          "id": 42
        },
        "qty_putaway": 123,
        "qty_committed": 123
      }
    ],
    "DeliveryItemLot": [
      {
        "type": "DeliveryItemLot",
        "id": 3,
        "lot": {
          "type": "Lot",
          "id": 54
        },
        "qty_counted": 123,
        "qty_putaway": 123
      }
    ],
    "DeliveryStatusHistory": [
      {
        "delivery_item": {
          "type": "DeliveryItem",
          "id": 3,
          "product": {
            "type": "Product",
            "id": 3
          },
          "quantity": 123,
          "qty_expected": 123,
          "qty_received": 123,
          "qty_shortage": 123,
          "qty_overage": 123,
          "qty_processed": 123,
          "qty_putaway": 123,
          "qty_committed": 123,
          "qty_returned": 123,
          "is_sku_merge_email_sent": true,
          "lots": [
            {
              "type": "DeliveryItemLot",
              "id": 3
            }
          ],
          "locations": [
            {
              "type": "DeliveryItemLocation",
              "id": 3
            }
          ],
          "exceptions": [
            {
              "type": "DeliveryException",
              "id": 3
            }
          ]
        },
        "status": "new",
        "exception": {
          "type": "Exception",
          "id": 123
        },
        "exception_status": "new",
        "comment": "<string>",
        "requester": {
          "type": "Requester",
          "id": 3
        },
        "created_at": "2017-07-21T17:32:28Z",
        "package": {
          "type": "Package",
          "id": 123
        }
      }
    ],
    "Lot": [
      {
        "type": "Lot",
        "id": 54
      }
    ],
    "Merchant": [
      {
        "type": "Merchant",
        "id": 4,
        "code": "acme_inc",
        "name": "ACME Inc.",
        "status": "active",
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z",
        "brands": [
          {
            "type": "Brand",
            "id": 4
          }
        ],
        "default_brand": {
          "type": "Brand",
          "id": 4
        }
      }
    ],
    "Product": [
      {
        "type": "Product",
        "id": 123,
        "vendor_sku": "Vendor-SKU-1AD2",
        "external_id": "11-993-9048",
        "barcodes": [
          "956623520-4",
          "O-VS-Oregano-p3"
        ],
        "goods_type": "NORMAL",
        "is_available": true,
        "is_visible": true,
        "lot_type": {
          "type": "LotType",
          "id": 4
        },
        "weight": {
          "value": 20,
          "unit": "lb"
        },
        "dimensions": {
          "length": 8,
          "width": 6,
          "height": 4,
          "unit": "in"
        },
        "volume": {
          "value": 300,
          "unit": "in^3"
        },
        "inventory": {
          "backorders": true,
          "dynamic_allocation": true,
          "virtual_inventory": "optimistic"
        },
        "export": {
          "description": "Plastic children's toy with steel weights and ball bearings",
          "customs_value": {
            "amount": 99,
            "currency": "USD"
          },
          "country_of_manufacture": "TW",
          "hs_base_code": "8518.30",
          "hs_country_extension": [
            {
              "country_id": "TW",
              "extension": "002"
            },
            {
              "country_id": "US",
              "extension": "011"
            }
          ]
        },
        "regulated_goods": {
          "regulation": {
            "type": "Regulation",
            "id": 123
          },
          "technical_name": "Hydro Polymer Acetylene Coating",
          "additional_information": "Flamable Liquid",
          "net_weight": {
            "value": 20,
            "unit": "lb"
          },
          "container_type": "Plastic Box",
          "container_meets_hazmat_specs": true,
          "regulation_units": 5
        },
        "packaging": {
          "require_packaging": true,
          "require_weight_check": true,
          "require_confirmation_per_item": true,
          "unit_quantity": 1,
          "bulk_quantity": 10,
          "max_per_package": 15,
          "is_ship_separately": true,
          "ship_separately_tag": "PVC",
          "can_tip": true,
          "can_contain_other_items": true,
          "is_handling_surcharge": true
        },
        "custom_fields": [
          {
            "code": "color",
            "value": 13,
            "label": "Red and Black"
          },
          {
            "code": "cost_of_goods",
            "value": 41.32
          },
          {
            "code": "allow_mailer",
            "value": true
          }
        ],
        "sku": "SKU-1AD",
        "name": "Test Product",
        "is_enabled": true,
        "merchant": {
          "type": "Merchant",
          "id": 4
        },
        "created_at": "2017-07-21T17:32:28Z",
        "updated_at": "2017-07-21T17:39:43Z"
      }
    ],
    "Requester": [
      {
        "type": "Requester",
        "id": 3,
        "entity_type": "OrganizationUser",
        "entity_id": 5,
        "name": "Bernard Greensmith",
        "status": "active"
      }
    ],
    "Warehouse": [
      {
        "type": "Warehouse",
        "id": 3,
        "name": "East Coast 1",
        "is_active": true
      }
    ]
  }
}

Authorizations

ā€‹
Authorization
string
header
required

Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization header prefixed with "Bearer" and then a single space.

Path Parameters

ā€‹
type
enum<string>
required

Specify the delivery type to which your operations will be restricted.

Available options:
asn,
rma,
other
ā€‹
id
integer<int32>
required

The id of the referenced Delivery.

Required range: x >= 1

Query Parameters

ā€‹
fields
enum<string>[]

Specify additional fields of the ASN OR RMA object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
customer_name,
carrier_name,
authorized_at,
delivered_at,
receive_by,
processed_at,
putaway_at,
completed_at,
ready_to_process_at,
merchant_rma_number,
merchant_status,
carrier_tracking_number,
merchant_order_number,
item_count,
container_count,
label_count,
exception_count,
processing_comments,
special_requirements,
is_auto_commit,
order,
created_at,
updated_at,
supplier_name,
expected_at,
merchant_reference,
supplier_invoice_reference,
supplier_order_reference,
shipment_type,
bill_of_lading,
tracking_numbers,
standard_carrier_alpha_code,
status_history,
items
ā€‹
fields:merchant
enum<string>[]

Specify additional fields of the Merchant object to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
code,
name,
status,
created_at,
updated_at,
brands,
default_brand
ā€‹
fields:warehouse
enum<string>[]

Specify additional fields of the Warehouse object to be included in the response.

Available options:
all
ā€‹
fields:status_history
enum<string>[]

Specify additional fields of the DeliveryStatusHistory object to be included in the response. See the selecting fields page for more information.

Available options:
all,
delivery_item,
status,
exception,
exception_status,
comment,
user,
created_at,
package
ā€‹
fields:items
enum<string>[]

Specify additional fields of the DeliveryItem objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
product,
quantity,
qty_expected,
qty_received,
qty_shortage,
qty_overage,
qty_processed,
qty_putaway,
qty_committed,
qty_returned,
is_sku_merge_email_sent,
lots,
locations,
exceptions
ā€‹
fields:items.exceptions
enum<string>[]

Specify additional fields of the DeliveryException objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
container,
lot,
status,
sign,
reason,
comment,
quantity
ā€‹
fields:items.lots
enum<string>[]

Specify additional fields of the DeliveryItemLot objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
all,
lot,
qty_counted,
qty_putaway
ā€‹
fields:items.locations
enum<string>[]

Specify additional fields of the DeliveryItemLocation objects nested under items to be included in the response. See the selecting fields page for more information.

Available options:
all,
location,
qty_putaway,
qty_committed
ā€‹
fields:containers
enum<string>[]

Specify additional fields of the DeliveryContainer objects to be included in the response. See the selecting fields page for more information.

Available options:
basic,
all,
label,
type,
status,
weight,
length,
width,
height,
total_skus,
total_qty,
contents

Response

OK

ā€‹
resource
ASN Ā· object

An ASN (Advanced Shipping Notification) delivery object.

ā€‹
included
object

Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.